API Documentation
Public Member Functions | List of all members
nkGraphics::EntityRenderInfoSlot Class Referencefinal

A slot within the render information. More...

Inheritance diagram for nkGraphics::EntityRenderInfoSlot:
nkExport::Exportable

Public Member Functions

 EntityRenderInfoSlot ()
 
 EntityRenderInfoSlot (const EntityRenderInfoSlot &other)
 
 EntityRenderInfoSlot (EntityRenderInfoSlot &&other)
 
 EntityRenderInfoSlot (Mesh *mesh, Shader *shader)
 
 ~EntityRenderInfoSlot ()
 
const nkMemory::BufferCast< EntityRenderLodSlot * > & getLods () const
 
EntitygetParentEntity () const
 
EntityRenderLodSlotaddLod (const EntityRenderLodSlot &lodSlot=EntityRenderLodSlot())
 
void eraseLod (unsigned int index)
 
EntityRenderInfoSlotoperator= (const EntityRenderInfoSlot &other)
 
EntityRenderInfoSlotoperator= (EntityRenderInfoSlot &&other)
 
virtual void exportClassToTree (nkExport::Node *rootNode) override
 
virtual void importClassFromTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkExport::Exportable
 Exportable ()
 
virtual ~Exportable ()
 

Detailed Description

A slot within the render information.

A slot can be seen as something that will be rendered by the default render strategy during a pass, after its LOD has been selected.

Constructor & Destructor Documentation

◆ EntityRenderInfoSlot() [1/4]

nkGraphics::EntityRenderInfoSlot::EntityRenderInfoSlot ( )

Default constructor.

◆ EntityRenderInfoSlot() [2/4]

nkGraphics::EntityRenderInfoSlot::EntityRenderInfoSlot ( const EntityRenderInfoSlot other)

Copy constructor.

Parameters
otherThe slot to copy from.

◆ EntityRenderInfoSlot() [3/4]

nkGraphics::EntityRenderInfoSlot::EntityRenderInfoSlot ( EntityRenderInfoSlot &&  other)

Move constructor.

Parameters
otherThe slot to move from.

◆ EntityRenderInfoSlot() [4/4]

nkGraphics::EntityRenderInfoSlot::EntityRenderInfoSlot ( Mesh mesh,
Shader shader 
)

Legacy convenience constructor. This will simply create a unique LOD within the slot.

Parameters
meshThe mesh to use.
shaderThe shader to use.

◆ ~EntityRenderInfoSlot()

nkGraphics::EntityRenderInfoSlot::~EntityRenderInfoSlot ( )

Destructor.

Member Function Documentation

◆ getLods()

const nkMemory::BufferCast<EntityRenderLodSlot*>& nkGraphics::EntityRenderInfoSlot::getLods ( ) const
Returns
A const reference over the buffer of lods within the slot.

◆ getParentEntity()

Entity* nkGraphics::EntityRenderInfoSlot::getParentEntity ( ) const
Returns
The parent entity, if available, nullptr else.

◆ addLod()

EntityRenderLodSlot* nkGraphics::EntityRenderInfoSlot::addLod ( const EntityRenderLodSlot lodSlot = EntityRenderLodSlot())

Adds a LOD to the slot.

Parameters
lodSlotA reference to copy from if required.
Returns
The newly created LOD.

◆ eraseLod()

void nkGraphics::EntityRenderInfoSlot::eraseLod ( unsigned int  index)

Erases an existing LOD.

Parameters
indexThe index of the LOD to erase.

◆ operator=() [1/2]

EntityRenderInfoSlot& nkGraphics::EntityRenderInfoSlot::operator= ( const EntityRenderInfoSlot other)

Copy assignment operator.

Parameters
otherThe slot to copy from.

◆ operator=() [2/2]

EntityRenderInfoSlot& nkGraphics::EntityRenderInfoSlot::operator= ( EntityRenderInfoSlot &&  other)

Move assignment operator.

Parameters
otherThe slot to move from.

◆ exportClassToTree()

virtual void nkGraphics::EntityRenderInfoSlot::exportClassToTree ( nkExport::Node rootNode)
overridevirtual

Basic exporting capabilities.

Parameters
rootNodeThe tree to export to.

Implements nkExport::Exportable.

◆ importClassFromTree()

virtual void nkGraphics::EntityRenderInfoSlot::importClassFromTree ( nkExport::Node rootNode)
overridevirtual

Basic importing capabilities.

Parameters
rootNodeThe tree to import from.

Implements nkExport::Exportable.


The documentation for this class was generated from the following file: